docs: catch up with recent repl merges (terminal integration, completion, global options, MCP prompts)#3
Conversation
…hain - terminal-integration: new "Shell integration marks (OSC 133 / OSC 633)" section (opt-in setup, mark table, modes, structural gates, E-mark privacy note, Windows Terminal settings note, ShellIntegrationStatus troubleshooting); move OSC 133 from "not yet implemented" to "currently in place". - customization: replace the speculative detection steps (COLORTERM, platform checks) with the actual chain — session override, AnsiMode, NO_COLOR, CLICOLOR_FORCE, TERM=dumb, redirection.
- repl-mode: Tab menu completes option names (route, global, result-flow), runs WithCompletion providers first with enum member fallback, and runs every registered provider (in-process). - cli-mode: document what shell completion returns, per-provider opt-in via CompletionProviderScope.InteractiveAndShell, provider timeout, and the two deliberate differences with the interactive menu. - configuration: mention the CompletionProviderScope argument. Covers yllibed/repl PRs #50 and #55. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- dependency-injection: show the AddGlobalOption overload with aliases, default value, and description; note the Global Options help section and that defaults are intentionally not displayed. - cli-mode: point the help section at global options. Covers yllibed/repl PRs #34 and #41. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Covers yllibed/repl PRs #48 and #49. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- customization: replace the generic 'Spectre detects automatically' claim with the actual behavior — host detection gates colors, tiered Unicode box-drawing fallback, CI enrichers disabled, and the SpectreTerminalDetection.CurrentBoxDrawingSupport diagnostic; drop a duplicated sentence. - terminal-integration: true-color is requested only when the host gate allows ANSI. Completes the passages deliberately deferred until yllibed/repl#47 merged (now in v0.11.0-dev.124+). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
@codex, please make a review here. |
autocarl
left a comment
There was a problem hiding this comment.
Quick documentation review of exact head 5c61ddcd253b6d4b32a2e9fa3b19f48f44d02f33. The content matches the corresponding repl implementation overall, and npm run docs:validate passes locally. One API-reference accuracy issue blocks approval: the configuration table documents a .WithCompletion(provider) overload that does not exist; see the inline comment. GitHub docs CI is green.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5c61ddcd25
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
- configuration: show the real WithCompletion overload shape (targetName, provider[, scope]) instead of a non-existent .WithCompletion(provider) form. - terminal-integration: add ShellIntegrationMarks and the vscode identity to the capability classifier table; note the OSC 633 dialect selection and ConEmu's deliberate exclusion. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
autocarl
left a comment
There was a problem hiding this comment.
Approved exact head 6be34f59dbf91b3ea226c8fb54725ee0b23260ce. The documented completion signature now matches the public CommandBuilder overloads (targetName, provider[, scope]). The additional terminal-capability table updates also match TerminalCapabilitiesClassifier (including vscode, ShellIntegrationMarks, and ConEmu exclusion). GitHub docs CI is green; local npm run docs:validate passes; git diff --check passes; detached worktree is clean; no review thread remains open.
Summary
Catches the hand-written docs up with the recent yllibed/repl merges, one commit per topic:
reference/terminal-integration.mdxgets the "Shell integration marks (OSC 133 / OSC 633)" section (opt-in setup, mark table, modes, structural gates, E-mark privacy note, Windows Terminal settings note,ShellIntegrationStatustroubleshooting);reference/customization.mdxreplaces the speculative detection steps with the actual chain (session override →AnsiMode→NO_COLOR→CLICOLOR_FORCE→TERM=dumb→ redirection).getting-started/repl-mode.mdxdocuments what the Tab menu completes (option names incl. global and result-flow flags,WithCompletionproviders first with enum member fallback);getting-started/cli-mode.mdxdocuments what shell completion returns, the per-provider opt-in viaCompletionProviderScope.InteractiveAndShell, the provider timeout, and the deliberate differences with the interactive menu;reference/configuration.mdxmentions the scope argument.reference/dependency-injection.mdxshows theAddGlobalOptionoverload with aliases/default/description and notes theGlobal Options:help section (defaults intentionally not displayed);getting-started/cli-mode.mdxpoints at it from the help section.reference/mcp-concepts.mdxnotes that non-optional route arguments arerequiredinprompts/listand that string-returning handlers surface plain text.SpectreTerminalDetection.CurrentBoxDrawingSupportdiagnostic), and true-color is requested only when the host gate allows ANSI.Covers yllibed/repl PRs #34, #41, #42, #47, #48, #49, #50, #55 (all included in
v0.11.0-dev.136).Verification
npm run docs:validate— passed (262 files checked).npm run build(DocFX API regeneration + Astro) run locally.🤖 Generated with Claude Code